home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / stats30.zip / STATS.DOC < prev    next >
Text File  |  1993-01-15  |  8KB  |  232 lines
  1.  
  2.                               The Stats Machine
  3.                                   Ver. 3.00
  4.                               Shareware Version
  5.                            
  6.                            A Wildcat! 3.XX Utility
  7.  
  8.                              Written by Tim Pryor
  9.  
  10.                      (C) 1991,92,93  UP Technologies, Inc.
  11.                              All Rights Reserved.
  12.  
  13.                               The Upper Limit BBS
  14.                                 (410) 860-0212
  15.                               300 - 14400 v.32bis
  16.                                  24 Hrs. 8/N/1
  17.  
  18.  
  19.  
  20.  
  21.                                   DISCLAIMER
  22.  
  23.     UP Technologies, Inc.  makes no warranty of any  kind, either expressed
  24.     or  implied,  including  but  not  limited  to  implied  warranties  of
  25.     merchantability and  fitness for a particular  purpose, with respect to
  26.     this software and accompanying documentation.
  27.  
  28.     IN  NO EVENT  SHALL UP  TECHNOLOGIES, INC.  BE LIABLE  FOR ANY  DAMAGES
  29.     (INCLUDING DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION,
  30.     LOSS OF BUSINESS  INFORMATION, OR OTHER PECUNIARY LOSS)  ARISING OUT OF
  31.     THE  USE  OF  OR  THE  INABILITY  TO  USE  THIS  PROGRAM,  EVEN  IF  UP
  32.     TECHNOLOGIES, INC. HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  33.  
  34.  
  35.                                    Trademarks
  36.              Wildcat! BBS is a trademark of Mustang Software, Inc.
  37.  
  38.  
  39.  
  40.     I. Introduction
  41.  
  42.     The Stats Machine is a useful sysop utility for Wildcat 3.02 and above,
  43.     which generates BBS statistics by reading the ACTIVITY.XXX file. Previous
  44.     versions of this program would only read the ACTIVITY.001 file. But
  45.     starting with this version, multi-line capability has been added!
  46.  
  47.     NOTE: Starting with this version (3.0), the Stats Machine is not
  48.     fully compatible with any version of Wildcat before 3.02. The program
  49.     will run, but several counters will not be calculated correctly.
  50.  
  51.     Currently the program will keep track of the following statistics:
  52.  
  53.          - # and % of calls for each baud rate (300,1200,2400,9600,14400,
  54.            and LOCAL)
  55.  
  56.          - # and % of calls per day of the week
  57.  
  58.          - # and % of calls per hour of the day
  59.  
  60.          - # and % of most type of logoffs (including normal, drop carrier,
  61.            exceeded time limit, no activity)
  62.  
  63.          - # and % of file transfers for each protocol
  64.  
  65.          - The top five most popular questionnaires (with corresponding #
  66.            and %) NOTE:This version only keeps track of the first 10
  67.            questionnaires. Future versions might include more.
  68.  
  69.          - # of downloads
  70.  
  71.          - # of uploads
  72.  
  73.          - # of new users
  74.  
  75.          - # of questionnaires answered
  76.  
  77.          - # of doors opened
  78.  
  79.          - # of times Sysop was paged
  80.  
  81.          - # of times newsletter was read
  82.  
  83.          - # of messages left
  84.  
  85.          - # and % of ANSI and non-ANSI calls
  86.  
  87.          - # and % of MNP and non-MNP calls
  88.  
  89.          - # and % of illegal logon attempts
  90.  
  91.          - # and % of cancelled file transfers
  92.  
  93.          - first and last date in ACTIVITY.001 file
  94.  
  95.          - misc. graphs
  96.  
  97.          - top ten doors, bulletins, file sections, and message bases
  98.  
  99.          - and a few other stats
  100.  
  101.  
  102.     NOTE: You may encounter an occasional problem with some of the numbers 
  103.     not adding up correctly; for example, total logons not equalling total 
  104.     logoffs, or total file transfers (by protocol) not equalling total 
  105.     uploads and downloads. The problem arises with the format of the 
  106.     ACTIVITY.xxx file used by Wildcat.  
  107.  
  108.  
  109.     The following files should be included in the zip file:
  110.  
  111.       STATS.CFG    - Config file
  112.       STATS.EXE    - The executable portion of The Stats Machine.
  113.       STATS.OVR    - Overlay file for The Stats Machine.
  114.       STATS.DOC    - The file you are reading right now.
  115.       ORDERFRM.DOC - Registration form.
  116.       SAMPLE.BBS   - Sample bulletin created with The Stats Machine
  117.       SAMPLEQ.BBS  - Sample 'QUICK' bulletin that can be created with
  118.                      the registered version of The Stats Machine.
  119.       SAMPLER.BBS  - Sample bulletin that can be created with the
  120.                      registered version of The Stats Machine. (Contains
  121.                      extra screens and information.)
  122.       CATALOG.TXT  - Listing of other Wildcat programs written by UP 
  123.                      Technologies, Inc. 
  124.       WHATS.NEW    - Latest information on The Stats Machine.
  125.  
  126.  
  127.     If any of  these files are missing, you can  always download the latest
  128.     version of The Stats Machine from The Upper Limit BBS at (410) 860-0212.
  129.  
  130.  
  131.  
  132.     II. Running The Stats Machine
  133.  
  134.     Previous versions of this program used optional parameters. Starting
  135.     with this version, a config file (STATS.CFG) is used. Any ASCII text
  136.     editor can be used to edit the file. The format is listed below:
  137.  
  138.     The Upper Limit BBS       <---BBS Name
  139.     1                         <---# of Nodes (up to 250)
  140.     C:\WC30\BULL\BULL1.BBS    <---Path and Filename of COLOR Bulletin
  141.     C:\WC30\BULL\BULL1.TXT    <---Path and Filename of MONO Bulletin
  142.     YES                       <---Create Graphs? (YES or NO)
  143.     YES                       <---Save Stat Totals? (YES or NO)
  144.  
  145.  
  146.     If you choose to save the stat totals, they will be saved in the file
  147.     STATS.DAT. Also, when saving the totals, the activity file will be
  148.     deleted upon completion of the Stats Machine. If you want to keep your
  149.     activity files, just make sure you copy them to another file before 
  150.     running this program.
  151.  
  152.     NOTE:If you are using previous versions of the Stats Machine and want
  153.     to upgrade, you must first delete your old STATS.DAT file. This was
  154.     necessary due to several changes in the format of the file. I hope
  155.     this is not too much of an inconvenience.
  156.  
  157.  
  158.     To run the program, type the following at the DOS prompt:
  159.  
  160.     STATS <ENTER>
  161.  
  162.     NOTE: If either the STATS.CFG or ACTIVITY.001 files are missing, the
  163.     program will terminate. No bulletins will be created. Also, in a
  164.     multi-node system, if any of the activity files are missing, the
  165.     program will also terminate. For example, if you specify that your
  166.     board has 5 nodes, but only 4 log files are found, the program will
  167.     abort and not produce any bulletins.
  168.  
  169.  
  170.  
  171.     IV. Registration
  172.  
  173.     The Stats Machine is not free, or in the public domain. It is
  174.     shareware, which means that you are expected to pay for it if you find
  175.     it useful. Registration is only $20 US. If you use The Stats Machine
  176.     for more than one month, you should register it. When you register The
  177.     Stats Machine, your board name will appear in the opening screen. For
  178.     more information on registering refer to the ORDERFRM.DOC file.
  179.  
  180.     When you register the Stats Machine, you get extra features, including:
  181.  
  182.  
  183.     * Ability to create a 'QUICK' one-screen file with the most important 
  184.       stats
  185.     
  186.     * Extra screens containing even more statistics
  187.  
  188.     * Sysop-selectable color in bulletins
  189.     
  190.     * Ability to select which screens to include in bulletins
  191.  
  192.     * And much more
  193.     
  194.     By registering The Stats Machine, this will provide me with encouragement
  195.     to add further enhancements and features.
  196.  
  197.  
  198.  
  199.     V. Acknowledgments
  200.  
  201.     I would like to thank everyone who has registered this program. I would 
  202.     also like to thank the following Sysops for their assistance:
  203.  
  204.               
  205.                                 Steve McCoy
  206.                                MCE Databoard
  207.                             300 - 14400 v.32bis
  208.                               (410) 543-2406
  209.    
  210.                                 Ted Schultz
  211.                          The Dominating Force BBS
  212.                             300 - 14400 v.32bis
  213.                                (410) 957-4534
  214.  
  215.  
  216.     
  217.  
  218.  
  219.     VI. Questions and Comments
  220.  
  221.     If you have any questions or comments concerning The Stats Machine,
  222.     you can contact me on my bbs:
  223.  
  224.  
  225.                               The Upper Limit BBS
  226.                                 (410) 860-0212
  227.                               300 - 14400 v.32bis
  228.                                  24 Hrs. 8/N/1
  229.  
  230.                         Full Access on Your First Call!
  231.                            No Fees or UL/DL Ratios!
  232.